<?php

/**
 * Zend Framework
 *
 * LICENSE
 *
 * This source file is subject to the new BSD license that is bundled
 * with this package in the file LICENSE.txt.
 * It is also available through the world-wide-web at this URL:
 * http://framework.zend.com/license/new-bsd
 * If you did not receive a copy of the license and are unable to
 * obtain it through the world-wide-web, please send an email
 * to license@zend.com so we can send you a copy immediately.
 *
 * @category   Zend
 * @package    Zend_Gdata
 * @subpackage Gapps
 * @copyright  Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)
 * @license    http://framework.zend.com/license/new-bsd     New BSD License
 * @version    $Id:$
 */

/**
 * @see Zend_Gdata_Entry
 */
require_once 'Zend/Gdata/Entry.php';

/**
 * @see Zend_Gdata_Gapps_Extension_Property
 */
require_once 'Zend/Gdata/Gapps/Extension/Property.php';

/**
 * Data model class for a Google Apps Owner Entry.
 *
 * Each owner entry describes a single owner within a Google Apps hosted
 * domain.
 *
 * To transfer owner entries to and from the Google Apps servers, including
 * creating new entries, refer to the Google Apps service class,
 * Zend_Gdata_Gapps.
 *
 * This class represents <atom:entry> in the Google Data protocol.
 *
 * @category   Zend
 * @package    Zend_Gdata
 * @subpackage Gapps
 * @copyright  Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)
 * @license    http://framework.zend.com/license/new-bsd     New BSD License
 */
class Zend_Gdata_Gapps_OwnerEntry extends Zend_Gdata_Entry {
	
	protected $_entryClassName = 'Zend_Gdata_Gapps_OwnerEntry';
	
	/**
	 * <apps:property> element containing information about other items
	 * relevant to this entry.
	 *
	 * @var Zend_Gdata_Gapps_Extension_Property
	 */
	protected $_property = array ();
	
	/**
	 * Create a new instance.
	 *
	 * @param DOMElement $element (optional) DOMElement from which this
	 * object should be constructed.
	 */
	public function __construct($element = null) {
		$this->registerAllNamespaces ( Zend_Gdata_Gapps::$namespaces );
		parent::__construct ( $element );
	}
	
	/**
	 * Retrieves a DOMElement which corresponds to this element and all
	 * child properties.  This is used to build an entry back into a DOM
	 * and eventually XML text for application storage/persistence.
	 *
	 * @param DOMDocument $doc The DOMDocument used to construct DOMElements
	 * @return DOMElement The DOMElement representing this element and all
	 * child properties.
	 */
	public function getDOM($doc = null, $majorVersion = 1, $minorVersion = null) {
		$element = parent::getDOM ( $doc, $majorVersion, $minorVersion );
		
		foreach ( $this->_property as $p ) {
			$element->appendChild ( $p->getDOM ( $element->ownerDocument ) );
		}
		return $element;
	}
	
	/**
	 * Creates individual Entry objects of the appropriate type and
	 * stores them as owners of this entry based upon DOM data.
	 *
	 * @param DOMNode $child The DOMNode to process
	 */
	protected function takeChildFromDOM($child) {
		$absoluteNodeName = $child->namespaceURI . ':' . $child->localName;
		
		switch ($absoluteNodeName) {
			
			case $this->lookupNamespace ( 'apps' ) . ':' . 'property' :
				$property = new Zend_Gdata_Gapps_Extension_Property ();
				$property->transferFromDOM ( $child );
				$this->_property [] = $property;
				break;
			default :
				parent::takeChildFromDOM ( $child );
				break;
		}
	}
	
	/**
	 * Returns all property tags for this entry
	 *
	 * @param string $rel The rel value of the property to be found. If null,
	 * the array of properties is returned instead.
	 * @return mixed Either an array of Zend_Gdata_Gapps_Extension_Property
	 * objects if $rel is null, a single
	 * Zend_Gdata_Gapps_Extension_Property object if $rel is specified
	 * and a matching feed link is found, or null if $rel is
	 * specified and no matching property is found.
	 */
	public function getProperty($rel = null) {
		if ($rel == null) {
			return $this->_property;
		} else {
			foreach ( $this->_property as $p ) {
				if ($p->rel == $rel) {
					return $p;
				}
			}
			return null;
		}
	}
	
	/**
	 * Set the value of the  property property for this object.
	 *
	 * @param array $value A collection of
	 * Zend_Gdata_Gapps_Extension_Property objects.
	 * @return Zend_Gdata_Gapps_OwnerEntry Provides a fluent interface.
	 */
	public function setProperty($value) {
		$this->_property = $value;
		return $this;
	}

}

